<meta name="viewport" content="width=device-width, initial-scale=1">

<link rel="apple-touch-icon-precomposed" sizes="144x144" href="../../assets/img/favicon-144.png">
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="../../assets/img/favicon-144.png">
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="../../assets/img/favicon-72.png">
<link rel="apple-touch-icon-precomposed" href="../../assets/img/favicon-32.png">
<link rel="shortcut icon" href="../../assets/img/favicon-32.png">

<link rel="stylesheet" href="../../assets/css/vk.css"/>
<link rel="stylesheet" href="../../assets/css/prism.css"/>


<vk-title>VkSparseImageMemoryRequirements | NVK</vk-title>

<vk-centered>

  <vk-navigation>
  <vk-search-title>Search</vk-search-title>
  <vk-search>
    <input type="text" id="search" autocomplete="off" />
    <vk-search-results>
      <ol id="search-list">
        <li id="no-search-results">No Results</li>
      </ol>
    </vk-search-results>
  </vk-search>
  <vk-section-title style="margin-top: 1em;">Categories</vk-section-title>
  <vk-categories></vk-categories>
</vk-navigation>


  <vk-struct>

    <vk-name>VkSparseImageMemoryRequirements</vk-name>

    <vk-description>Structure specifying sparse image memory requirements</vk-description>

    <vk-section-title>Syntax</vk-section-title>
    <vk-syntax>
      <pre><code class="language-js">sparseImageMemoryRequirements = new VkSparseImageMemoryRequirements();</code></pre>
    </vk-syntax>

    <vk-section-title>Stub <vk-property-type type="read-only">read-only</vk-property-type></vk-section-title>
    
    <vk-property-prototype id="expand-code" class="expand-btn"></vk-property-prototype>

    <vk-stub id="code-no-expand" style="display:none;">
      <pre><code class="language-js">let sparseImageMemoryRequirements = new VkSparseImageMemoryRequirements();
sparseImageMemoryRequirements.formatProperties;
sparseImageMemoryRequirements.imageMipTailFirstLod;
sparseImageMemoryRequirements.imageMipTailSize;
sparseImageMemoryRequirements.imageMipTailOffset;
sparseImageMemoryRequirements.imageMipTailStride;
</code></pre>
    </vk-stub>

    <vk-stub id="code-expanded" style="display:none;">
      <pre><code class="language-js">let sparseImageMemoryRequirements = new VkSparseImageMemoryRequirements();
sparseImageMemoryRequirements.formatProperties;
sparseImageMemoryRequirements.imageMipTailFirstLod;
sparseImageMemoryRequirements.imageMipTailSize;
sparseImageMemoryRequirements.imageMipTailOffset;
sparseImageMemoryRequirements.imageMipTailStride;
</code></pre>
    </vk-stub><vk-section-title>Properties</vk-section-title>

    <vk-properties>
      <vk-property-entry>
        <vk-property-prototype>VkSparseImageMemoryRequirements.prototype.<vk-prototype-name>formatProperties</vk-prototype-name></vk-property-prototype>
        <vk-property-type type="object"><a href="../structs/VkSparseImageFormatProperties.html">VkSparseImageFormatProperties</a></vk-property-type>
        <vk-property-description></vk-property-description>
      </vk-property-entry>
      <vk-property-entry>
        <vk-property-prototype>VkSparseImageMemoryRequirements.prototype.<vk-prototype-name>imageMipTailFirstLod</vk-prototype-name></vk-property-prototype>
        <vk-property-type type="number">Number</vk-property-type>
        <vk-property-description> is the first mip level at which image subresources are included in the mip tail region.</vk-property-description>
      </vk-property-entry>
      <vk-property-entry>
        <vk-property-prototype>VkSparseImageMemoryRequirements.prototype.<vk-prototype-name>imageMipTailSize</vk-prototype-name></vk-property-prototype>
        <vk-property-type type="number"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt">BigInt</a></vk-property-type>
      <vk-property-type type="number">Number</vk-property-type>
        <vk-property-description> is the memory size (in bytes) of the mip tail region. If <b>formatProperties.flags</b> contains <b>VK_SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT</b>, this is the size of the whole mip tail, otherwise this is the size of the mip tail of a single array layer. This value is guaranteed to be a multiple of the sparse block size in bytes.</vk-property-description>
      </vk-property-entry>
      <vk-property-entry>
        <vk-property-prototype>VkSparseImageMemoryRequirements.prototype.<vk-prototype-name>imageMipTailOffset</vk-prototype-name></vk-property-prototype>
        <vk-property-type type="number"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt">BigInt</a></vk-property-type>
      <vk-property-type type="number">Number</vk-property-type>
        <vk-property-description> is the opaque memory offset used with <b><a href="../structs/VkSparseImageOpaqueMemoryBindInfo.html">VkSparseImageOpaqueMemoryBindInfo</a></b> to bind the mip tail region(s).</vk-property-description>
      </vk-property-entry>
      <vk-property-entry>
        <vk-property-prototype>VkSparseImageMemoryRequirements.prototype.<vk-prototype-name>imageMipTailStride</vk-prototype-name></vk-property-prototype>
        <vk-property-type type="number"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt">BigInt</a></vk-property-type>
      <vk-property-type type="number">Number</vk-property-type>
        <vk-property-description> is the offset stride between each array-layer's mip tail, if <b>formatProperties.flags</b> does not contain <b>VK_SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT</b> (otherwise the value is <b style="text-decoration:underline;">undefined</b>).</vk-property-description>
      </vk-property-entry>
      
    </vk-properties>

    <vk-section-title>Default Properties</vk-section-title>

    <vk-properties>
      <vk-property-entry>
        <vk-property-prototype>VkSparseImageMemoryRequirements.prototype.<vk-prototype-name>memoryBuffer</vk-prototype-name></vk-property-prototype>
        <vk-property-type type="arraybuffer"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer">ArrayBuffer</a></vk-property-type>
        <vk-property-description>Native memory reference of the structure.</vk-property-description>
      </vk-property-entry>
      <vk-property-entry>
        <vk-property-prototype>VkSparseImageMemoryRequirements.<vk-prototype-name>memoryLayout</vk-prototype-name></vk-property-prototype>
        <vk-property-type type="object">Object</vk-property-type>
        <vk-property-description>Object describing this structure's memory layout.</vk-property-description>
      </vk-property-entry>
      <vk-property-entry>
        <vk-property-prototype>VkSparseImageMemoryRequirements.<vk-prototype-name>byteLength</vk-prototype-name></vk-property-prototype>
        <vk-property-type type="number">Number</vk-property-type>
        <vk-property-description>Total native byte length of this structure.</vk-property-description>
      </vk-property-entry>
    </vk-properties>

  </vk-struct>

</vk-centered>

<script>
const IS_ROOT = false;
</script>

<script type="text/javascript" src="../../assets/js/prism.min.js"></script>
<script type="text/javascript" src="../../assets/js/index.js"></script>
